Skip to content

feat(asgi): Gate client IP/user info behind data_collection config#6841

Merged
ericapisani merged 58 commits into
masterfrom
py-2586-gate-user-data
Jul 22, 2026
Merged

feat(asgi): Gate client IP/user info behind data_collection config#6841
ericapisani merged 58 commits into
masterfrom
py-2586-gate-user-data

Conversation

@ericapisani

@ericapisani ericapisani commented Jul 17, 2026

Copy link
Copy Markdown
Member

Apply data_collection.user_info filtering to REMOTE_ADDR/client.address,
falling back to send_default_pii when data_collection is not configured.

Also convert earlier query parameter data collection tests to end-to-end assertions via a real ASGI app.

Ref PY-2586
Ref #6746

…n config

`_filter_headers` previously used a hardcoded sensitive-header tuple and a
`send_default_pii`/`use_annotated_value` toggle. It now delegates to
`_apply_key_value_collection_filtering` from `sentry_sdk.data_collection`,
so header scrubbing respects the new `data_collection.http_headers.request`
allowlist/denylist/off configuration.

Cookie and set-cookie headers are
always redacted regardless of mode. Drops the now-unused
`use_annotated_value` parameter from all call sites.

Work to scrub cookies in a more granular way will be tackled as part of
PY-2581/#6741.

Fixes PY-2584
Fixes #6744
…ures

The new lambda_functions_with_embedded_sdk fixture directories were
missing the .gitignore that the other fixtures use to keep everything
except index.py untracked. As a result, certifi and urllib3 packages
installed by the test setup got committed, and ruff failed CI linting
against them since they're unmodified third-party code.

Add the missing .gitignore to each new fixture directory and remove
the committed vendored packages; they are regenerated automatically at
test time via `uv pip install --target`.
…tarlette, litestar, starlite

Extends the granular cookie collection controls (data_collection.cookies)
to _wsgi_common, starlette, litestar, and starlite, matching the behavior
already used elsewhere. Falls back to should_send_default_pii() when
data_collection is not configured for cookies.

HTTP "Cookie" and "set-cookie" headers will continue to be completely filtered
with the "[Filtered]" value.

Fixes PY-2581
Fixes #6741
…de is off

Previously the async request extractors attached an empty cookies dict
when the data_collection cookies mode was off, while sync route handlers
omitted it entirely. Make all integrations consistent by not attaching
the cookies field at all when filtering yields no cookies.
…n config

`_filter_headers` previously used a hardcoded sensitive-header tuple and a
`send_default_pii`/`use_annotated_value` toggle. It now delegates to
`_apply_key_value_collection_filtering` from `sentry_sdk.data_collection`,
so header scrubbing respects the new `data_collection.http_headers.request`
allowlist/denylist/off configuration.

Cookie and set-cookie headers are
always redacted regardless of mode. Drops the now-unused
`use_annotated_value` parameter from all call sites.

Work to scrub cookies in a more granular way will be tackled as part of
PY-2581/#6741.

Fixes PY-2584
Fixes #6744
…ures

The new lambda_functions_with_embedded_sdk fixture directories were
missing the .gitignore that the other fixtures use to keep everything
except index.py untracked. As a result, certifi and urllib3 packages
installed by the test setup got committed, and ruff failed CI linting
against them since they're unmodified third-party code.

Add the missing .gitignore to each new fixture directory and remove
the committed vendored packages; they are regenerated automatically at
test time via `uv pip install --target`.
…ntry/sentry-python into py-2584-update-wsgi-filter-headers
…tarlette, litestar, starlite

Extends the granular cookie collection controls (data_collection.cookies)
to _wsgi_common, starlette, litestar, and starlite, matching the behavior
already used elsewhere. Falls back to should_send_default_pii() when
data_collection is not configured for cookies.

HTTP "Cookie" and "set-cookie" headers will continue to be completely filtered
with the "[Filtered]" value.

Fixes PY-2581
Fixes #6741
…de is off

Previously the async request extractors attached an empty cookies dict
when the data_collection cookies mode was off, while sync route handlers
omitted it entirely. Make all integrations consistent by not attaching
the cookies field at all when filtering yields no cookies.
The streaming path no longer emits a client span when there is no current
span (#6810), so unpack only the server span.
Filter WSGI request event and span query strings through the
data_collection.url_query_params behaviour (denylist/allowlist/off)
instead of gating query string capture solely on send_default_pii.
This brings WSGI-based integrations in line with the data collection
spec's handling of cookies and headers.

Rename the data_collection field query_params to url_query_params to
match the updated data collection spec, which distinguishes URL query
params from other key-value data (cookies, headers). Update the
DataCollection/DataCollectionUserOptions TypedDicts, resolution logic
in data_collection.py, and all WSGI/Flask/Django test coverage
accordingly.

Refs PY-2583
Apply data_collection.user_info filtering to REMOTE_ADDR/client.address,
falling back to send_default_pii when data_collection is not configured.

Also convert earlier query parameter data collection tests to end-to-end assertions via a real ASGI app.

Ref PY-2586
Ref #6746
@linear-code

linear-code Bot commented Jul 17, 2026

Copy link
Copy Markdown

PY-2586

Comment thread sentry_sdk/integrations/_asgi_common.py
Comment thread tests/integrations/asgi/test_asgi.py
@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Codecov Results 📊

94546 passed | ⏭️ 6340 skipped | Total: 100886 | Pass Rate: 93.72% | Execution Time: 326m 37s

📊 Comparison with Base Branch

Metric Change
Total Tests 📈 +1454
Passed Tests 📈 +1453
Failed Tests 📉 -1
Skipped Tests 📈 +2

All tests are passing successfully.

❌ Patch coverage is 49.21%. Project has 2511 uncovered lines.
❌ Project coverage is 89.64%. Comparing base (base) to head (head).

Files with missing lines (2)
File Patch % Lines
sentry_sdk/integrations/gcp.py 5.56% ⚠️ 17 Missing
sentry_sdk/integrations/aws_lambda.py 6.25% ⚠️ 15 Missing
Coverage diff
@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
- Coverage    89.66%    89.64%    -0.02%
==========================================
  Files          193       193         —
  Lines        24239     24248        +9
  Branches      8502      8514       +12
==========================================
+ Hits         21733     21737        +4
- Misses        2506      2511        +5
- Partials      1396      1394        -2

Generated by Codecov Action

@ericapisani
ericapisani marked this pull request as ready for review July 20, 2026 15:27
@ericapisani
ericapisani requested a review from a team as a code owner July 20, 2026 15:27

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Want reviews to match your repository better? Bugbot Learning can learn team-specific rules from PR activity. A team admin can enable Learning in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 8c9f43d. Configure here.

Comment thread sentry_sdk/integrations/_asgi_common.py
Comment thread tests/integrations/starlette/test_starlette.py
Comment thread sentry_sdk/integrations/_asgi_common.py
Base automatically changed from py-2583-query-params-aws to master July 22, 2026 19:11
@ericapisani
ericapisani merged commit 2b55359 into master Jul 22, 2026
267 of 269 checks passed
@ericapisani
ericapisani deleted the py-2586-gate-user-data branch July 22, 2026 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants